<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<!-- Content Stylesheet for Site -->

        
<!-- start the processing -->
    <!-- ====================================================================== -->
    <!-- Main Page Section -->
    <!-- ====================================================================== -->
    <html>
        <head>
            <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>

                                                    <meta name="author" value="Cort Schaefer">
            <meta name="email" value="cort@xmission.com">
            
           
                                    
            <title>NVelocity - NVelocity</title>
	    <link rel="SHORTCUT ICON" href="..//images/favicon.ico">
	    <link rel="stylesheet" type="text/css" href="..//css/nvelocity.css">

<link rel="stylesheet" type="text/css" href="..//css/nant-task.css">
        </head>

        <body bgcolor="#ffffff" text="#000000" link="#525D76">        
	<table border="0" width="100%" cellspacing="0" ID="Table2">
	    <tr>
		<td align="left">
		    <A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=58632&amp;type=5" width="210" height="62" border="0" alt="SourceForge Logo"></A>
		</td>
		<td align="right">
		    <a href="http://nvelocity.sourceforge.net" style="text-decoration: none;">
			<span class="title">NVelocity</span></a>
		</td>
	    </tr>
	</table>
	<br>


            <table border="0" width="100%" cellspacing="4">
                <tr><td colspan="2">
                    <hr noshade="" size="1"/>
                </td></tr>
                
                <tr>
                    <!-- LEFT SIDE NAVIGATION -->
                    <td width="20%" valign="top" nowrap="true">
                                <p><strong>About</strong></p>
        <ul>
                    <li>    <a href="../index.html">Overview</a>
</li>
                    <li>    <a href="http://sourceforge.net/project/showfiles.php?group_id=58632">Download</a>
</li>
                    <li>    <a href="../changelog.html">ChangeLog</a>
</li>
                </ul>
            <p><strong>Community</strong></p>
        <ul>
                    <li>    <a href="http://sourceforge.net/projects/nvelocity">Project Summary</a>
</li>
                    <li>    <a href="http://sourceforge.net/mail/?group_id=58632">Mailing Lists</a>
</li>
                    <li>    <a href="http://sourceforge.net/cvs/?group_id=58632">CVS Repositories</a>
</li>
                </ul>
            <p><strong>Docs</strong></p>
        <ul>
                    <li>    <a href="../api/overview-summary.html">API Specs</a>
</li>
                    <li>    <a href="../nant/index.html">NAnt Tasks</a>
</li>
                    <li>    <a href="http://jakarta.apache.org/velocity/vtl-reference-guide.html">VTL Reference Guide</a>
</li>
                </ul>
            <p><strong>Related Sites</strong></p>
        <ul>
                    <li>    <a href="http://jakarta.apache.org/velocity">Velocity (the original)</a>
</li>
                    <li>    <a href="http://sourceforge.net/projects/mavnet">Maverick.Net</a>
</li>
                    <li>    <a href="http://sourceforge.net/projects/nant">NAnt</a>
</li>
                </ul>
                        </td>
                    <td width="80%" align="left" valign="top">
                        <h1>anakia</h1>
    <p>
	Anakia is a XML transformation tool that uses NVelocity templates merged with XML documents to transform XML into the format of your choice.  This page was generated using the AnakiaTask.
	</p>
    <h3>Parameters</h3>
    <div class="Table-Section">
      <table class="Table">
        <tr>
          <th class="Table-Header">Attribute</th>
          <th class="Table-Header">Description</th>
          <th class="Table-Header" align="left">Required</th>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>destdir</td>
          <td class="Table-Cell" align=left>Directory in which to store the results.</td>
          <td class="Table-Cell" align=left>true</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>extension</td>
          <td class="Table-Cell" align=left>This is the extension that is appended to the end of your .xml file. For example, with an extension of ".html", index.xml would be converted into index.html. By default, the extension is .html.</td>
          <td class="Table-Cell" align=left>false</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>style</td>
          <td class="Table-Cell" align=left>This is the path to the .vsl template</td>
          <td class="Table-Cell" align=left>true</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>projectFile</td>
          <td class="Table-Cell" align=left>This is the path to a "project" file. This file is an XML file that can be used as a "navigation" file. If you look at the Anakia example in the NVelocity/examples/anakia directory, you can see the project.xml file being used in the .vsl file.</td>
          <td class="Table-Cell" align=left>false</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>lastModifiedCheck</td>
          <td class="Table-Cell" align=left>This turns on or off the ability to check the last modified date on files in order to determine whether or not they need to be re-rendered or not. The value of this attribute can be "true, false, yes, no". By default, it is true, meaning that the last modified date should be checked and if the original .xml file, project file, or .vsl file have not changed, then don't process the page. This accelerates processing because pages that have not changed will not get reprocessed.</td>
          <td class="Table-Cell" align=left>false</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>templatePath</td>
          <td class="Table-Cell" align=left>This is the path to the templateRoot which is the directory where your site.vsl file is located. This can be defined in the nvelocity.properties or it can be defined here. It it an optional argument if it is defined in the NVelocity properties file already. However, if defined, this value will override the path defined in the nvelocity.properties file.</td>
          <td class="Table-Cell" align=left>true</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>propertiesFile</td>
          <td class="Table-Cell" align=left>This is the path to the nvelocity.properties file. It is an optional argument and by default is set to find the properties file in the same directory that the JVM was started in.</td>
          <td class="Table-Cell" align=left>false</td>
        </tr>
      </table>
    </div>

    <h3>Context Objects</h3>
    <div class="Table-Section">
      <table class="Table">
        <tr>
          <th class="Table-Header">Name</th>
          <th class="Table-Header">Description</th>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$root</td>
          <td class="Table-Cell" align=left>This contains the root XmlElement to your .xml document. When this (or any other variable containing an element) are simply placed into template output, their XML form is rendered.</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$project</td>
          <td class="Table-Cell" align=left>This contains the root XmlElement to your project.xml document. If you have not specified a project.xml document, then this variable will not be in the context.</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$escape.GetText($string)</td>
          <td class="Table-Cell" align=left>This context object will convert HTML Entities in the $string that is passed into it and it will return the converted String. This is good for dealing with CDATA. The entities that are converted are: " -> &quot; | < -> &lt; | > -> &gt; | & - > &amp; </td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$relativePath</td>
          <td class="Table-Cell" align=left>This contains a String which is the relative path to your .xml document from the BaseDirectory of the fileset that was specified in your NAnt task attributes. Please see the examples/anakia .vsl document for example usage of this String.</td>
        </tr>
        <tr>
          <td class="Table-Cell" valign="top" align=left>$date</td>
          <td class="Table-Cell" align=left>This is an instance of System.Date.Now. Useful for putting the current date/time into a page.</td>
        </tr>
      </table>
    </div>


    <h3>Examples</h3>
    <p class="i1">This is the task definition to create the NVelocity site documentation</p><pre class="code">&lt;anakia basedir="../xdocs" 
    destdir="../wwwsite"
    extension=".html" 
    style="../xdocs/stylesheets/site.vsl"
    projectFile="../xdocs/stylesheets/project.xml"
    templatePath="../xdocs/stylesheets"
    lastModifiedCheck="true"&gt;
	&lt;fileset basedir="../xdocs"&gt;
                &lt;includes name="**/*.xml"/&gt;
		&lt;excludes name="**/stylesheets/*" /&gt;
	&lt;/fileset&gt;
&lt;/anakia&gt;
 </pre>
                    </td>
                </tr>

                <!-- FOOTER -->
                <tr><td colspan="2">
                    <hr noshade="" size="1"/>
                </td></tr>
                <tr><td colspan="2">
                    <div align="center"><font color="#525D76" size="-1">
		    <!-- <em>Copyright &#169; 2002, Cort Schaefer</em> -->
		    </font>
		    </div>
                </td></tr>
            </table>
        </body>
    </html>

<!-- end the processing -->





















